3 * Base code for file repositories.
10 * Base class for file repositories
17 const DELETE_SOURCE
= 1;
19 const OVERWRITE_SAME
= 4;
20 const SKIP_LOCKING
= 8;
21 const ALLOW_STALE
= 16;
23 /** @var FileBackendBase */
25 /** @var Array Map of zones to config */
26 protected $zones = array();
28 var $thumbScriptUrl, $transformVia404;
29 var $descBaseUrl, $scriptDirUrl, $scriptExtension, $articleUrl;
30 var $fetchDescription, $initialCapital;
31 var $pathDisclosureProtection = 'simple'; // 'paranoid'
32 var $descriptionCacheExpiry, $url, $thumbUrl;
33 var $hashLevels, $deletedHashLevels;
36 * Factory functions for creating new files
37 * Override these in the base class
39 var $fileFactory = array( 'UnregisteredLocalFile', 'newFromTitle' );
40 var $oldFileFactory = false;
41 var $fileFactoryKey = false, $oldFileFactoryKey = false;
43 function __construct( $info ) {
45 $this->name
= $info['name'];
46 if ( $info['backend'] instanceof FileBackendBase
) {
47 $this->backend
= $info['backend']; // useful for testing
49 $this->backend
= FileBackendGroup
::singleton()->get( $info['backend'] );
52 // Optional settings that can have no value
53 $optionalSettings = array(
54 'descBaseUrl', 'scriptDirUrl', 'articleUrl', 'fetchDescription',
55 'thumbScriptUrl', 'pathDisclosureProtection', 'descriptionCacheExpiry',
58 foreach ( $optionalSettings as $var ) {
59 if ( isset( $info[$var] ) ) {
60 $this->$var = $info[$var];
64 // Optional settings that have a default
65 $this->initialCapital
= isset( $info['initialCapital'] )
66 ?
$info['initialCapital']
67 : MWNamespace
::isCapitalized( NS_FILE
);
68 $this->url
= isset( $info['url'] )
70 : false; // a subclass may set the URL (e.g. ForeignAPIRepo)
71 if ( isset( $info['thumbUrl'] ) ) {
72 $this->thumbUrl
= $info['thumbUrl'];
74 $this->thumbUrl
= $this->url ?
"{$this->url}/thumb" : false;
76 $this->hashLevels
= isset( $info['hashLevels'] )
79 $this->deletedHashLevels
= isset( $info['deletedHashLevels'] )
80 ?
$info['deletedHashLevels']
82 $this->transformVia404
= !empty( $info['transformVia404'] );
83 $this->zones
= isset( $info['zones'] )
86 // Give defaults for the basic zones...
87 foreach ( array( 'public', 'thumb', 'temp', 'deleted' ) as $zone ) {
88 if ( !isset( $this->zones
[$zone] ) ) {
89 $this->zones
[$zone] = array(
90 'container' => "{$this->name}-{$zone}",
91 'directory' => '' // container root
98 * Get the file backend instance
100 * @return FileBackendBase
102 public function getBackend() {
103 return $this->backend
;
107 * Prepare a single zone or list of zones for usage.
108 * See initDeletedDir() for additional setup needed for the 'deleted' zone.
110 * @param $doZones Array Only do a particular zones
113 protected function initZones( $doZones = array() ) {
114 $status = $this->newGood();
115 foreach ( (array)$doZones as $zone ) {
116 $root = $this->getZonePath( $zone );
117 if ( $root === null ) {
118 throw new MWException( "No '$zone' zone defined in the {$this->name} repo." );
125 * Take all available measures to prevent web accessibility of new deleted
126 * directories, in case the user has not configured offline storage
131 protected function initDeletedDir( $dir ) {
132 $this->backend
->secure( // prevent web access & dir listings
133 array( 'dir' => $dir, 'noAccess' => true, 'noListing' => true ) );
137 * Determine if a string is an mwrepo:// URL
142 public static function isVirtualUrl( $url ) {
143 return substr( $url, 0, 9 ) == 'mwrepo://';
147 * Get a URL referring to this repository, with the private mwrepo protocol.
148 * The suffix, if supplied, is considered to be unencoded, and will be
149 * URL-encoded before being returned.
151 * @param $suffix string
154 public function getVirtualUrl( $suffix = false ) {
155 $path = 'mwrepo://' . $this->name
;
156 if ( $suffix !== false ) {
157 $path .= '/' . rawurlencode( $suffix );
163 * Get the URL corresponding to one of the four basic zones
165 * @param $zone String: one of: public, deleted, temp, thumb
166 * @return String or false
168 public function getZoneUrl( $zone ) {
173 return "{$this->url}/temp";
175 return false; // no public URL
177 return $this->thumbUrl
;
184 * Get the backend storage path corresponding to a virtual URL
189 function resolveVirtualUrl( $url ) {
190 if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
191 throw new MWException( __METHOD__
.': unknown protocol' );
193 $bits = explode( '/', substr( $url, 9 ), 3 );
194 if ( count( $bits ) != 3 ) {
195 throw new MWException( __METHOD__
.": invalid mwrepo URL: $url" );
197 list( $repo, $zone, $rel ) = $bits;
198 if ( $repo !== $this->name
) {
199 throw new MWException( __METHOD__
.": fetching from a foreign repo is not supported" );
201 $base = $this->getZonePath( $zone );
203 throw new MWException( __METHOD__
.": invalid zone: $zone" );
205 return $base . '/' . rawurldecode( $rel );
209 * The the storage container and base path of a zone
211 * @param $zone string
212 * @return Array (container, base path) or (null, null)
214 protected function getZoneLocation( $zone ) {
215 if ( !isset( $this->zones
[$zone] ) ) {
216 return array( null, null ); // bogus
218 return array( $this->zones
[$zone]['container'], $this->zones
[$zone]['directory'] );
222 * Get the storage path corresponding to one of the zones
224 * @param $zone string
225 * @return string|null
227 public function getZonePath( $zone ) {
228 list( $container, $base ) = $this->getZoneLocation( $zone );
229 if ( $container === null ||
$base === null ) {
232 $backendName = $this->backend
->getName();
233 if ( $base != '' ) { // may not be set
236 return "mwstore://$backendName/{$container}{$base}";
240 * Create a new File object from the local repository
242 * @param $title Mixed: Title object or string
243 * @param $time Mixed: Time at which the image was uploaded.
244 * If this is specified, the returned object will be an
245 * instance of the repository's old file class instead of a
246 * current file. Repositories not supporting version control
247 * should return false if this parameter is set.
248 * @return File|null A File, or null if passed an invalid Title
250 public function newFile( $title, $time = false ) {
251 $title = File
::normalizeTitle( $title );
256 if ( $this->oldFileFactory
) {
257 return call_user_func( $this->oldFileFactory
, $title, $this, $time );
262 return call_user_func( $this->fileFactory
, $title, $this );
267 * Find an instance of the named file created at the specified time
268 * Returns false if the file does not exist. Repositories not supporting
269 * version control should return false if the time is specified.
271 * @param $title Mixed: Title object or string
272 * @param $options array Associative array of options:
273 * time: requested time for an archived image, or false for the
274 * current version. An image object will be returned which was
275 * created at the specified time.
277 * ignoreRedirect: If true, do not follow file redirects
279 * private: If true, return restricted (deleted) files if the current
280 * user is allowed to view them. Otherwise, such files will not
284 public function findFile( $title, $options = array() ) {
285 $title = File
::normalizeTitle( $title );
289 $time = isset( $options['time'] ) ?
$options['time'] : false;
290 # First try the current version of the file to see if it precedes the timestamp
291 $img = $this->newFile( $title );
295 if ( $img->exists() && ( !$time ||
$img->getTimestamp() == $time ) ) {
298 # Now try an old version of the file
299 if ( $time !== false ) {
300 $img = $this->newFile( $title, $time );
301 if ( $img && $img->exists() ) {
302 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
303 return $img; // always OK
304 } elseif ( !empty( $options['private'] ) && $img->userCan( File
::DELETED_FILE
) ) {
311 if ( !empty( $options['ignoreRedirect'] ) ) {
314 $redir = $this->checkRedirect( $title );
315 if ( $redir && $title->getNamespace() == NS_FILE
) {
316 $img = $this->newFile( $redir );
320 if ( $img->exists() ) {
321 $img->redirectedFrom( $title->getDBkey() );
329 * Find many files at once.
331 * @param $items An array of titles, or an array of findFile() options with
332 * the "title" option giving the title. Example:
334 * $findItem = array( 'title' => $title, 'private' => true );
335 * $findBatch = array( $findItem );
336 * $repo->findFiles( $findBatch );
339 public function findFiles( $items ) {
341 foreach ( $items as $item ) {
342 if ( is_array( $item ) ) {
343 $title = $item['title'];
345 unset( $options['title'] );
350 $file = $this->findFile( $title, $options );
352 $result[$file->getTitle()->getDBkey()] = $file;
359 * Find an instance of the file with this key, created at the specified time
360 * Returns false if the file does not exist. Repositories not supporting
361 * version control should return false if the time is specified.
363 * @param $sha1 String base 36 SHA-1 hash
364 * @param $options Option array, same as findFile().
367 public function findFileFromKey( $sha1, $options = array() ) {
368 $time = isset( $options['time'] ) ?
$options['time'] : false;
370 # First try to find a matching current version of a file...
371 if ( $this->fileFactoryKey
) {
372 $img = call_user_func( $this->fileFactoryKey
, $sha1, $this, $time );
374 return false; // find-by-sha1 not supported
376 if ( $img && $img->exists() ) {
379 # Now try to find a matching old version of a file...
380 if ( $time !== false && $this->oldFileFactoryKey
) { // find-by-sha1 supported?
381 $img = call_user_func( $this->oldFileFactoryKey
, $sha1, $this, $time );
382 if ( $img && $img->exists() ) {
383 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
384 return $img; // always OK
385 } elseif ( !empty( $options['private'] ) && $img->userCan( File
::DELETED_FILE
) ) {
394 * Get an array or iterator of file objects for files that have a given
395 * SHA-1 content hash.
399 public function findBySha1( $hash ) {
404 * Get the public root URL of the repository
406 * @return string|false
408 public function getRootUrl() {
413 * Returns true if the repository uses a multi-level directory structure
417 public function isHashed() {
418 return (bool)$this->hashLevels
;
422 * Get the URL of thumb.php
426 public function getThumbScriptUrl() {
427 return $this->thumbScriptUrl
;
431 * Returns true if the repository can transform files via a 404 handler
435 public function canTransformVia404() {
436 return $this->transformVia404
;
440 * Get the name of an image from its title object
442 * @param $title Title
444 public function getNameFromTitle( Title
$title ) {
446 if ( $this->initialCapital
!= MWNamespace
::isCapitalized( NS_FILE
) ) {
447 $name = $title->getUserCaseDBKey();
448 if ( $this->initialCapital
) {
449 $name = $wgContLang->ucfirst( $name );
452 $name = $title->getDBkey();
458 * Get the public zone root storage directory of the repository
462 public function getRootDirectory() {
463 return $this->getZonePath( 'public' );
467 * Get a relative path including trailing slash, e.g. f/fa/
468 * If the repo is not hashed, returns an empty string
470 * @param $name string
473 public function getHashPath( $name ) {
474 return self
::getHashPathForLevel( $name, $this->hashLevels
);
482 static function getHashPathForLevel( $name, $levels ) {
483 if ( $levels == 0 ) {
486 $hash = md5( $name );
488 for ( $i = 1; $i <= $levels; $i++
) {
489 $path .= substr( $hash, 0, $i ) . '/';
496 * Get the number of hash directory levels
500 public function getHashLevels() {
501 return $this->hashLevels
;
505 * Get the name of this repository, as specified by $info['name]' to the constructor
509 public function getName() {
514 * Make an url to this repo
516 * @param $query mixed Query string to append
517 * @param $entry string Entry point; defaults to index
518 * @return string|false
520 public function makeUrl( $query = '', $entry = 'index' ) {
521 if ( isset( $this->scriptDirUrl
) ) {
522 $ext = isset( $this->scriptExtension
) ?
$this->scriptExtension
: '.php';
523 return wfAppendQuery( "{$this->scriptDirUrl}/{$entry}{$ext}", $query );
529 * Get the URL of an image description page. May return false if it is
530 * unknown or not applicable. In general this should only be called by the
531 * File class, since it may return invalid results for certain kinds of
532 * repositories. Use File::getDescriptionUrl() in user code.
534 * In particular, it uses the article paths as specified to the repository
535 * constructor, whereas local repositories use the local Title functions.
537 * @param $name string
540 public function getDescriptionUrl( $name ) {
541 $encName = wfUrlencode( $name );
542 if ( !is_null( $this->descBaseUrl
) ) {
543 # "http://example.com/wiki/Image:"
544 return $this->descBaseUrl
. $encName;
546 if ( !is_null( $this->articleUrl
) ) {
547 # "http://example.com/wiki/$1"
549 # We use "Image:" as the canonical namespace for
550 # compatibility across all MediaWiki versions.
551 return str_replace( '$1',
552 "Image:$encName", $this->articleUrl
);
554 if ( !is_null( $this->scriptDirUrl
) ) {
555 # "http://example.com/w"
557 # We use "Image:" as the canonical namespace for
558 # compatibility across all MediaWiki versions,
559 # and just sort of hope index.php is right. ;)
560 return $this->makeUrl( "title=Image:$encName" );
566 * Get the URL of the content-only fragment of the description page. For
567 * MediaWiki this means action=render. This should only be called by the
568 * repository's file class, since it may return invalid results. User code
569 * should use File::getDescriptionText().
571 * @param $name String: name of image to fetch
572 * @param $lang String: language to fetch it in, if any.
575 public function getDescriptionRenderUrl( $name, $lang = null ) {
576 $query = 'action=render';
577 if ( !is_null( $lang ) ) {
578 $query .= '&uselang=' . $lang;
580 if ( isset( $this->scriptDirUrl
) ) {
581 return $this->makeUrl(
583 wfUrlencode( 'Image:' . $name ) .
586 $descUrl = $this->getDescriptionUrl( $name );
588 return wfAppendQuery( $descUrl, $query );
596 * Get the URL of the stylesheet to apply to description pages
598 * @return string|false
600 public function getDescriptionStylesheetUrl() {
601 if ( isset( $this->scriptDirUrl
) ) {
602 return $this->makeUrl( 'title=MediaWiki:Filepage.css&' .
603 wfArrayToCGI( Skin
::getDynamicStylesheetQuery() ) );
609 * Store a file to a given destination.
611 * @param $srcPath String: source FS path, storage path, or virtual URL
612 * @param $dstZone String: destination zone
613 * @param $dstRel String: destination relative path
614 * @param $flags Integer: bitwise combination of the following flags:
615 * self::DELETE_SOURCE Delete the source file after upload
616 * self::OVERWRITE Overwrite an existing destination file instead of failing
617 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
618 * same contents as the source
619 * self::SKIP_LOCKING Skip any file locking when doing the store
620 * self::ALLOW_STALE Don't require latest data for existence checks
621 * @return FileRepoStatus
623 public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
624 $status = $this->storeBatch( array( array( $srcPath, $dstZone, $dstRel ) ), $flags );
625 if ( $status->successCount
== 0 ) {
632 * Store a batch of files
634 * @param $triplets Array: (src, dest zone, dest rel) triplets as per store()
635 * @param $flags Integer: bitwise combination of the following flags:
636 * self::DELETE_SOURCE Delete the source file after upload
637 * self::OVERWRITE Overwrite an existing destination file instead of failing
638 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
639 * same contents as the source
640 * self::SKIP_LOCKING Skip any file locking when doing the store
641 * @return FileRepoStatus
643 public function storeBatch( $triplets, $flags = 0 ) {
644 $backend = $this->backend
; // convenience
646 $status = $this->newGood();
648 $operations = array();
649 $sourceFSFilesToDelete = array(); // cleanup for disk source files
650 // Validate each triplet and get the store operation...
651 foreach ( $triplets as $triplet ) {
652 list( $srcPath, $dstZone, $dstRel ) = $triplet;
654 // Resolve destination path
655 $root = $this->getZonePath( $dstZone );
657 throw new MWException( "Invalid zone: $dstZone" );
659 if ( !$this->validateFilename( $dstRel ) ) {
660 throw new MWException( 'Validation error in $dstRel' );
662 $dstPath = "$root/$dstRel";
663 $dstDir = dirname( $dstPath );
665 // Create destination directories for this triplet
666 if ( !$backend->prepare( array( 'dir' => $dstDir ) )->isOK() ) {
667 return $this->newFatal( 'directorycreateerror', $dstDir );
670 if ( $dstZone == 'deleted' ) {
671 $this->initDeletedDir( $dstDir );
674 // Resolve source to a storage path if virtual
675 if ( self
::isVirtualUrl( $srcPath ) ) {
676 $srcPath = $this->resolveVirtualUrl( $srcPath );
679 // Get the appropriate file operation
680 if ( FileBackend
::isStoragePath( $srcPath ) ) {
681 $opName = ( $flags & self
::DELETE_SOURCE
) ?
'move' : 'copy';
684 if ( $flags & self
::DELETE_SOURCE
) {
685 $sourceFSFilesToDelete[] = $srcPath;
688 $operations[] = array(
692 'overwriteDest' => $flags & self
::OVERWRITE
,
693 'overwriteSame' => $flags & self
::OVERWRITE_SAME
,
697 // Execute the store operation for each triplet
698 $opts = array( 'force' => true );
699 if ( $flags & self
::SKIP_LOCKING
) {
700 $opts['nonLocking'] = true;
702 if ( $flags & self
::ALLOW_STALE
) {
703 $opts['allowStale'] = true;
705 $status->merge( $backend->doOperations( $operations, $opts ) );
706 // Cleanup for disk source files...
707 foreach ( $sourceFSFilesToDelete as $file ) {
708 wfSuppressWarnings();
709 unlink( $file ); // FS cleanup
717 * Deletes a batch of files.
718 * Each file can be a (zone, rel) pair, virtual url, storage path, or FS path.
719 * It will try to delete each file, but ignores any errors that may occur.
721 * @param $pairs array List of files to delete
724 public function cleanupBatch( $files ) {
725 $operations = array();
726 $sourceFSFilesToDelete = array(); // cleanup for disk source files
727 foreach ( $files as $file ) {
728 if ( is_array( $file ) ) {
729 // This is a pair, extract it
730 list( $zone, $rel ) = $file;
731 $root = $this->getZonePath( $zone );
732 $path = "$root/$rel";
734 if ( self
::isVirtualUrl( $file ) ) {
735 // This is a virtual url, resolve it
736 $path = $this->resolveVirtualUrl( $file );
738 // This is a full file name
742 // Get a file operation if needed
743 if ( FileBackend
::isStoragePath( $path ) ) {
744 $operations[] = array(
749 $sourceFSFilesToDelete[] = $path;
752 // Actually delete files from storage...
753 $opts = array( 'force' => true );
754 $this->backend
->doOperations( $operations, $opts );
755 // Cleanup for disk source files...
756 foreach ( $sourceFSFilesToDelete as $file ) {
757 wfSuppressWarnings();
758 unlink( $file ); // FS cleanup
764 * Pick a random name in the temp zone and store a file to it.
765 * Returns a FileRepoStatus object with the URL in the value.
767 * @param $originalName String: the base name of the file as specified
768 * by the user. The file extension will be maintained.
769 * @param $srcPath String: the current location of the file.
770 * @return FileRepoStatus object with the URL in the value.
772 public function storeTemp( $originalName, $srcPath ) {
773 $date = gmdate( "YmdHis" );
774 $hashPath = $this->getHashPath( $originalName );
775 $dstRel = "{$hashPath}{$date}!{$originalName}";
776 $dstUrlRel = $hashPath . $date . '!' . rawurlencode( $originalName );
778 $result = $this->store( $srcPath, 'temp', $dstRel, self
::SKIP_LOCKING
);
779 $result->value
= $this->getVirtualUrl( 'temp' ) . '/' . $dstUrlRel;
784 * Concatenate a list of files into a target file location.
786 * @param $srcPaths Array Ordered list of source virtual URLs/storage paths
787 * @param $dstPath String Target file system path
788 * @param $flags Integer: bitwise combination of the following flags:
789 * self::DELETE_SOURCE Delete the source files
790 * @return FileRepoStatus
792 function concatenate( $srcPaths, $dstPath, $flags = 0 ) {
793 $status = $this->newGood();
796 $deleteOperations = array(); // post-concatenate ops
797 foreach ( $srcPaths as $srcPath ) {
798 // Resolve source to a storage path if virtual
799 $source = $this->resolveToStoragePath( $srcPath );
800 $sources[] = $source; // chunk to merge
801 if ( $flags & self
::DELETE_SOURCE
) {
802 $deleteOperations[] = array( 'op' => 'delete', 'src' => $source );
806 // Concatenate the chunks into one FS file
807 $params = array( 'srcs' => $sources, 'dst' => $dstPath );
808 $status->merge( $this->backend
->concatenate( $params ) );
809 if ( !$status->isOK() ) {
813 // Delete the sources if required
814 if ( $deleteOperations ) {
815 $opts = array( 'force' => true );
816 $status->merge( $this->backend
->doOperations( $deleteOperations, $opts ) );
819 // Make sure status is OK, despite any $deleteOperations fatals
820 $status->setResult( true );
826 * Remove a temporary file or mark it for garbage collection
828 * @param $virtualUrl String: the virtual URL returned by storeTemp
829 * @return Boolean: true on success, false on failure
831 public function freeTemp( $virtualUrl ) {
832 $temp = "mwrepo://{$this->name}/temp";
833 if ( substr( $virtualUrl, 0, strlen( $temp ) ) != $temp ) {
834 wfDebug( __METHOD__
.": Invalid temp virtual URL\n" );
837 $path = $this->resolveVirtualUrl( $virtualUrl );
838 $op = array( 'op' => 'delete', 'src' => $path );
839 $status = $this->backend
->doOperation( $op );
840 return $status->isOK();
844 * Copy or move a file either from a storage path, virtual URL,
845 * or FS path, into this repository at the specified destination location.
847 * Returns a FileRepoStatus object. On success, the value contains "new" or
848 * "archived", to indicate whether the file was new with that name.
850 * @param $srcPath String: the source FS path, storage path, or URL
851 * @param $dstRel String: the destination relative path
852 * @param $archiveRel String: the relative path where the existing file is to
853 * be archived, if there is one. Relative to the public zone root.
854 * @param $flags Integer: bitfield, may be FileRepo::DELETE_SOURCE to indicate
855 * that the source file should be deleted if possible
857 public function publish( $srcPath, $dstRel, $archiveRel, $flags = 0 ) {
858 $status = $this->publishBatch( array( array( $srcPath, $dstRel, $archiveRel ) ), $flags );
859 if ( $status->successCount
== 0 ) {
862 if ( isset( $status->value
[0] ) ) {
863 $status->value
= $status->value
[0];
865 $status->value
= false;
871 * Publish a batch of files
873 * @param $triplets Array: (source, dest, archive) triplets as per publish()
874 * @param $flags Integer: bitfield, may be FileRepo::DELETE_SOURCE to indicate
875 * that the source files should be deleted if possible
876 * @return FileRepoStatus
878 public function publishBatch( $triplets, $flags = 0 ) {
879 $backend = $this->backend
; // convenience
881 // Try creating directories
882 $status = $this->initZones( 'public' );
883 if ( !$status->isOK() ) {
887 $status = $this->newGood( array() );
889 $operations = array();
890 $sourceFSFilesToDelete = array(); // cleanup for disk source files
891 // Validate each triplet and get the store operation...
892 foreach ( $triplets as $i => $triplet ) {
893 list( $srcPath, $dstRel, $archiveRel ) = $triplet;
894 // Resolve source to a storage path if virtual
895 if ( substr( $srcPath, 0, 9 ) == 'mwrepo://' ) {
896 $srcPath = $this->resolveVirtualUrl( $srcPath );
898 if ( !$this->validateFilename( $dstRel ) ) {
899 throw new MWException( 'Validation error in $dstRel' );
901 if ( !$this->validateFilename( $archiveRel ) ) {
902 throw new MWException( 'Validation error in $archiveRel' );
905 $publicRoot = $this->getZonePath( 'public' );
906 $dstPath = "$publicRoot/$dstRel";
907 $archivePath = "$publicRoot/$archiveRel";
909 $dstDir = dirname( $dstPath );
910 $archiveDir = dirname( $archivePath );
911 // Abort immediately on directory creation errors since they're likely to be repetitive
912 if ( !$backend->prepare( array( 'dir' => $dstDir ) )->isOK() ) {
913 return $this->newFatal( 'directorycreateerror', $dstDir );
915 if ( !$backend->prepare( array( 'dir' => $archiveDir ) )->isOK() ) {
916 return $this->newFatal( 'directorycreateerror', $archiveDir );
919 // Archive destination file if it exists
920 if ( $backend->fileExists( array( 'src' => $dstPath ) ) ) {
921 // Check if the archive file exists
922 // This is a sanity check to avoid data loss. In UNIX, the rename primitive
923 // unlinks the destination file if it exists. DB-based synchronisation in
924 // publishBatch's caller should prevent races. In Windows there's no
925 // problem because the rename primitive fails if the destination exists.
926 if ( $backend->fileExists( array( 'src' => $archivePath ) ) ) {
927 $operations[] = array( 'op' => 'null' );
930 $operations[] = array(
933 'dst' => $archivePath
936 $status->value
[$i] = 'archived';
938 $status->value
[$i] = 'new';
940 // Copy (or move) the source file to the destination
941 if ( FileBackend
::isStoragePath( $srcPath ) ) {
942 if ( $flags & self
::DELETE_SOURCE
) {
943 $operations[] = array(
949 $operations[] = array(
955 } else { // FS source path
956 $operations[] = array(
961 if ( $flags & self
::DELETE_SOURCE
) {
962 $sourceFSFilesToDelete[] = $srcPath;
967 // Execute the operations for each triplet
968 $opts = array( 'force' => true );
969 $status->merge( $backend->doOperations( $operations, $opts ) );
970 // Cleanup for disk source files...
971 foreach ( $sourceFSFilesToDelete as $file ) {
972 wfSuppressWarnings();
973 unlink( $file ); // FS cleanup
981 * Checks existence of a a file
983 * @param $file Virtual URL (or storage path) of file to check
984 * @param $flags Integer: bitwise combination of the following flags:
985 * self::FILES_ONLY Mark file as existing only if it is a file (not directory)
988 public function fileExists( $file, $flags = 0 ) {
989 $result = $this->fileExistsBatch( array( $file ), $flags );
994 * Checks existence of an array of files.
996 * @param $files Array: Virtual URLs (or storage paths) of files to check
997 * @param $flags Integer: bitwise combination of the following flags:
998 * self::FILES_ONLY Mark file as existing only if it is a file (not directory)
999 * @return Either array of files and existence flags, or false
1001 public function fileExistsBatch( $files, $flags = 0 ) {
1003 foreach ( $files as $key => $file ) {
1004 if ( self
::isVirtualUrl( $file ) ) {
1005 $file = $this->resolveVirtualUrl( $file );
1007 if ( FileBackend
::isStoragePath( $file ) ) {
1008 $result[$key] = $this->backend
->fileExists( array( 'src' => $file ) );
1010 if ( $flags & self
::FILES_ONLY
) {
1011 $result[$key] = is_file( $file ); // FS only
1013 $result[$key] = file_exists( $file ); // FS only
1022 * Move a file to the deletion archive.
1023 * If no valid deletion archive exists, this may either delete the file
1024 * or throw an exception, depending on the preference of the repository
1026 * @param $srcRel Mixed: relative path for the file to be deleted
1027 * @param $archiveRel Mixed: relative path for the archive location.
1028 * Relative to a private archive directory.
1029 * @return FileRepoStatus object
1031 public function delete( $srcRel, $archiveRel ) {
1032 return $this->deleteBatch( array( array( $srcRel, $archiveRel ) ) );
1036 * Move a group of files to the deletion archive.
1038 * If no valid deletion archive is configured, this may either delete the
1039 * file or throw an exception, depending on the preference of the repository.
1041 * The overwrite policy is determined by the repository -- currently LocalRepo
1042 * assumes a naming scheme in the deleted zone based on content hash, as
1043 * opposed to the public zone which is assumed to be unique.
1045 * @param $sourceDestPairs Array of source/destination pairs. Each element
1046 * is a two-element array containing the source file path relative to the
1047 * public root in the first element, and the archive file path relative
1048 * to the deleted zone root in the second element.
1049 * @return FileRepoStatus
1051 public function deleteBatch( $sourceDestPairs ) {
1052 $backend = $this->backend
; // convenience
1054 // Try creating directories
1055 $status = $this->initZones( array( 'public', 'deleted' ) );
1056 if ( !$status->isOK() ) {
1060 $status = $this->newGood();
1062 $operations = array();
1063 // Validate filenames and create archive directories
1064 foreach ( $sourceDestPairs as $pair ) {
1065 list( $srcRel, $archiveRel ) = $pair;
1066 if ( !$this->validateFilename( $srcRel ) ) {
1067 throw new MWException( __METHOD__
.':Validation error in $srcRel' );
1069 if ( !$this->validateFilename( $archiveRel ) ) {
1070 throw new MWException( __METHOD__
.':Validation error in $archiveRel' );
1073 $publicRoot = $this->getZonePath( 'public' );
1074 $srcPath = "{$publicRoot}/$srcRel";
1076 $deletedRoot = $this->getZonePath( 'deleted' );
1077 $archivePath = "{$deletedRoot}/{$archiveRel}";
1078 $archiveDir = dirname( $archivePath ); // does not touch FS
1080 // Create destination directories
1081 if ( !$backend->prepare( array( 'dir' => $archiveDir ) )->isOK() ) {
1082 return $this->newFatal( 'directorycreateerror', $archiveDir );
1084 $this->initDeletedDir( $archiveDir );
1086 $operations[] = array(
1089 'dst' => $archivePath,
1090 // We may have 2+ identical files being deleted,
1091 // all of which will map to the same destination file
1092 'overwriteSame' => true
1096 // Move the files by execute the operations for each pair.
1097 // We're now committed to returning an OK result, which will
1098 // lead to the files being moved in the DB also.
1099 $opts = array( 'force' => true );
1100 $status->merge( $backend->doOperations( $operations, $opts ) );
1106 * Get a relative path for a deletion archive key,
1107 * e.g. s/z/a/ for sza251lrxrc1jad41h5mgilp8nysje52.jpg
1111 public function getDeletedHashPath( $key ) {
1113 for ( $i = 0; $i < $this->deletedHashLevels
; $i++
) {
1114 $path .= $key[$i] . '/';
1120 * If a path is a virtual URL, resolve it to a storage path.
1121 * Otherwise, just return the path as it is.
1123 * @param $path string
1125 * @throws MWException
1127 protected function resolveToStoragePath( $path ) {
1128 if ( $this->isVirtualUrl( $path ) ) {
1129 return $this->resolveVirtualUrl( $path );
1135 * Get a local FS copy of a file with a given virtual URL/storage path.
1136 * Temporary files may be purged when the file object falls out of scope.
1138 * @param $virtualUrl string
1139 * @return TempFSFile|null Returns null on failure
1141 public function getLocalCopy( $virtualUrl ) {
1142 $path = $this->resolveToStoragePath( $virtualUrl );
1143 return $this->backend
->getLocalCopy( array( 'src' => $path ) );
1147 * Get a local FS file with a given virtual URL/storage path.
1148 * The file is either an original or a copy. It should not be changed.
1149 * Temporary files may be purged when the file object falls out of scope.
1151 * @param $virtualUrl string
1152 * @return FSFile|null Returns null on failure.
1154 public function getLocalReference( $virtualUrl ) {
1155 $path = $this->resolveToStoragePath( $virtualUrl );
1156 return $this->backend
->getLocalReference( array( 'src' => $path ) );
1160 * Get properties of a file with a given virtual URL/storage path.
1161 * Properties should ultimately be obtained via FSFile::getProps().
1163 * @param $virtualUrl string
1166 public function getFileProps( $virtualUrl ) {
1167 $path = $this->resolveToStoragePath( $virtualUrl );
1168 return $this->backend
->getFileProps( array( 'src' => $path ) );
1172 * Get the timestamp of a file with a given virtual URL/storage path
1174 * @param $virtualUrl string
1175 * @return string|false
1177 public function getFileTimestamp( $virtualUrl ) {
1178 $path = $this->resolveToStoragePath( $virtualUrl );
1179 return $this->backend
->getFileTimestamp( array( 'src' => $path ) );
1183 * Get the sha1 of a file with a given virtual URL/storage path
1185 * @param $virtualUrl string
1186 * @return string|false
1188 public function getFileSha1( $virtualUrl ) {
1189 $path = $this->resolveToStoragePath( $virtualUrl );
1190 $tmpFile = $this->backend
->getLocalReference( array( 'src' => $path ) );
1194 return $tmpFile->getSha1Base36();
1198 * Attempt to stream a file with the given virtual URL/storage path
1200 * @param $virtualUrl string
1201 * @param $headers Array Additional HTTP headers to send on success
1202 * @return bool Success
1204 public function streamFile( $virtualUrl, $headers = array() ) {
1205 $path = $this->resolveToStoragePath( $virtualUrl );
1206 $params = array( 'src' => $path, 'headers' => $headers );
1207 return $this->backend
->streamFile( $params )->isOK();
1211 * Call a callback function for every public regular file in the repository.
1212 * This only acts on the current version of files, not any old versions.
1213 * May use either the database or the filesystem.
1215 * @param $callback Array|string
1218 public function enumFiles( $callback ) {
1219 $this->enumFilesInStorage( $callback );
1223 * Call a callback function for every public file in the repository.
1224 * May use either the database or the filesystem.
1226 * @param $callback Array|string
1229 protected function enumFilesInStorage( $callback ) {
1230 $publicRoot = $this->getZonePath( 'public' );
1231 $numDirs = 1 << ( $this->hashLevels
* 4 );
1232 // Use a priori assumptions about directory structure
1233 // to reduce the tree height of the scanning process.
1234 for ( $flatIndex = 0; $flatIndex < $numDirs; $flatIndex++
) {
1235 $hexString = sprintf( "%0{$this->hashLevels}x", $flatIndex );
1236 $path = $publicRoot;
1237 for ( $hexPos = 0; $hexPos < $this->hashLevels
; $hexPos++
) {
1238 $path .= '/' . substr( $hexString, 0, $hexPos +
1 );
1240 $iterator = $this->backend
->getFileList( array( 'dir' => $path ) );
1241 foreach ( $iterator as $name ) {
1242 // Each item returned is a public file
1243 call_user_func( $callback, "{$path}/{$name}" );
1249 * Determine if a relative path is valid, i.e. not blank or involving directory traveral
1251 * @param $filename string
1254 public function validateFilename( $filename ) {
1255 if ( strval( $filename ) == '' ) {
1258 if ( wfIsWindows() ) {
1259 $filename = strtr( $filename, '\\', '/' );
1262 * Use the same traversal protection as Title::secureAndSplit()
1264 if ( strpos( $filename, '.' ) !== false &&
1265 ( $filename === '.' ||
$filename === '..' ||
1266 strpos( $filename, './' ) === 0 ||
1267 strpos( $filename, '../' ) === 0 ||
1268 strpos( $filename, '/./' ) !== false ||
1269 strpos( $filename, '/../' ) !== false ) )
1278 * Get a callback function to use for cleaning error message parameters
1282 function getErrorCleanupFunction() {
1283 switch ( $this->pathDisclosureProtection
) {
1285 $callback = array( $this, 'passThrough' );
1288 $callback = array( $this, 'simpleClean' );
1290 default: // 'paranoid'
1291 $callback = array( $this, 'paranoidClean' );
1297 * Path disclosure protection function
1299 * @param $param string
1302 function paranoidClean( $param ) {
1307 * Path disclosure protection function
1309 * @param $param string
1312 function simpleClean( $param ) {
1314 if ( !isset( $this->simpleCleanPairs
) ) {
1315 $this->simpleCleanPairs
= array(
1316 $IP => '$IP', // sanity
1319 return strtr( $param, $this->simpleCleanPairs
);
1323 * Path disclosure protection function
1325 * @param $param string
1328 function passThrough( $param ) {
1333 * Create a new fatal error
1335 * @return FileRepoStatus
1337 function newFatal( $message /*, parameters...*/ ) {
1338 $params = func_get_args();
1339 array_unshift( $params, $this );
1340 return MWInit
::callStaticMethod( 'FileRepoStatus', 'newFatal', $params );
1344 * Create a new good result
1346 * @return FileRepoStatus
1348 function newGood( $value = null ) {
1349 return FileRepoStatus
::newGood( $this, $value );
1353 * Delete files in the deleted directory if they are not referenced in the filearchive table
1357 public function cleanupDeletedBatch( $storageKeys ) {}
1360 * Checks if there is a redirect named as $title. If there is, return the
1361 * title object. If not, return false.
1364 * @param $title Title of image
1367 public function checkRedirect( Title
$title ) {
1372 * Invalidates image redirect cache related to that image
1373 * Doesn't do anything for repositories that don't support image redirects.
1376 * @param $title Title of image
1378 public function invalidateImageRedirect( Title
$title ) {}
1381 * Get the human-readable name of the repo
1385 public function getDisplayName() {
1386 // We don't name our own repo, return nothing
1387 if ( $this->isLocal() ) {
1390 // 'shared-repo-name-wikimediacommons' is used when $wgUseInstantCommons = true
1391 return wfMessageFallback( 'shared-repo-name-' . $this->name
, 'shared-repo' )->text();
1395 * Returns true if this the local file repository.
1399 public function isLocal() {
1400 return $this->getName() == 'local';
1404 * Get a key on the primary cache for this repository.
1405 * Returns false if the repository's cache is not accessible at this site.
1406 * The parameters are the parts of the key, as for wfMemcKey().
1410 function getSharedCacheKey( /*...*/ ) {
1415 * Get a key for this repo in the local cache domain. These cache keys are
1416 * not shared with remote instances of the repo.
1417 * The parameters are the parts of the key, as for wfMemcKey().
1421 function getLocalCacheKey( /*...*/ ) {
1422 $args = func_get_args();
1423 array_unshift( $args, 'filerepo', $this->getName() );
1424 return call_user_func_array( 'wfMemcKey', $args );
1428 * Get an UploadStash associated with this repo.
1430 * @return UploadStash
1432 public function getUploadStash() {
1433 return new UploadStash( $this );